<!-- HTML header for doxygen 1.8.9.1-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
<title>Compute Library: FileHandler Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Compute Library
   &#160;<span id="projectnumber">18.03</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.xhtml"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.xhtml"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="inherits.xhtml"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.xhtml"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classarm__compute_1_1io_1_1_file_handler.xhtml','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">FileHandler Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>File Handling interface.  
 <a href="classarm__compute_1_1io_1_1_file_handler.xhtml#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_file_handler_8h_source.xhtml">FileHandler.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7a105e8757c6bbbe0e6be820ce84f1ed"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#a7a105e8757c6bbbe0e6be820ce84f1ed">FileHandler</a> ()</td></tr>
<tr class="memdesc:a7a105e8757c6bbbe0e6be820ce84f1ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Constructor.  <a href="#a7a105e8757c6bbbe0e6be820ce84f1ed">More...</a><br /></td></tr>
<tr class="separator:a7a105e8757c6bbbe0e6be820ce84f1ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af21f1ebc53f4b79a0cda634bef0a6137"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#af21f1ebc53f4b79a0cda634bef0a6137">~FileHandler</a> ()</td></tr>
<tr class="memdesc:af21f1ebc53f4b79a0cda634bef0a6137"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default Destructor.  <a href="#af21f1ebc53f4b79a0cda634bef0a6137">More...</a><br /></td></tr>
<tr class="separator:af21f1ebc53f4b79a0cda634bef0a6137"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad5e81d7f7b3728303469466afa8909dd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#ad5e81d7f7b3728303469466afa8909dd">FileHandler</a> (<a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:ad5e81d7f7b3728303469466afa8909dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#ad5e81d7f7b3728303469466afa8909dd">More...</a><br /></td></tr>
<tr class="separator:ad5e81d7f7b3728303469466afa8909dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91b520f21421ff8fe1326635142276a9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#a91b520f21421ff8fe1326635142276a9">FileHandler</a> (const <a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> &amp;)=delete</td></tr>
<tr class="memdesc:a91b520f21421ff8fe1326635142276a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a91b520f21421ff8fe1326635142276a9">More...</a><br /></td></tr>
<tr class="separator:a91b520f21421ff8fe1326635142276a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ffd691a00a5c9080528c3b852bda144"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#a9ffd691a00a5c9080528c3b852bda144">operator=</a> (const <a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> &amp;)=delete</td></tr>
<tr class="memdesc:a9ffd691a00a5c9080528c3b852bda144"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent instances of this class from being copied (As this class contains pointers)  <a href="#a9ffd691a00a5c9080528c3b852bda144">More...</a><br /></td></tr>
<tr class="separator:a9ffd691a00a5c9080528c3b852bda144"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54f342231c056055100190a5429e4689"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#a54f342231c056055100190a5429e4689">operator=</a> (<a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> &amp;&amp;)=default</td></tr>
<tr class="memdesc:a54f342231c056055100190a5429e4689"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allow instances of this class to be moved.  <a href="#a54f342231c056055100190a5429e4689">More...</a><br /></td></tr>
<tr class="separator:a54f342231c056055100190a5429e4689"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6d6ff37ab6cae622a54e37c16dd53b2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#aa6d6ff37ab6cae622a54e37c16dd53b2">open</a> (const std::string &amp;<a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#a16182afd0af6163476284de586c66c9d">filename</a>, std::ios_base::openmode mode)</td></tr>
<tr class="memdesc:aa6d6ff37ab6cae622a54e37c16dd53b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opens file.  <a href="#aa6d6ff37ab6cae622a54e37c16dd53b2">More...</a><br /></td></tr>
<tr class="separator:aa6d6ff37ab6cae622a54e37c16dd53b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ae591df94fc66ccb85cbb6565368bca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#a5ae591df94fc66ccb85cbb6565368bca">close</a> ()</td></tr>
<tr class="memdesc:a5ae591df94fc66ccb85cbb6565368bca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes file.  <a href="#a5ae591df94fc66ccb85cbb6565368bca">More...</a><br /></td></tr>
<tr class="separator:a5ae591df94fc66ccb85cbb6565368bca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a480926182a1f0b657c56803bc0122386"><td class="memItemLeft" align="right" valign="top">std::fstream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#a480926182a1f0b657c56803bc0122386">stream</a> ()</td></tr>
<tr class="memdesc:a480926182a1f0b657c56803bc0122386"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the file stream.  <a href="#a480926182a1f0b657c56803bc0122386">More...</a><br /></td></tr>
<tr class="separator:a480926182a1f0b657c56803bc0122386"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16182afd0af6163476284de586c66c9d"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml#a16182afd0af6163476284de586c66c9d">filename</a> () const </td></tr>
<tr class="memdesc:a16182afd0af6163476284de586c66c9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns filename of the handled file.  <a href="#a16182afd0af6163476284de586c66c9d">More...</a><br /></td></tr>
<tr class="separator:a16182afd0af6163476284de586c66c9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>File Handling interface. </p>

<p>Definition at line <a class="el" href="_file_handler_8h_source.xhtml#l00035">35</a> of file <a class="el" href="_file_handler_8h_source.xhtml">FileHandler.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a7a105e8757c6bbbe0e6be820ce84f1ed"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default Constructor. </p>

</div>
</div>
<a class="anchor" id="af21f1ebc53f4b79a0cda634bef0a6137"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">~<a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Default Destructor. </p>

</div>
</div>
<a class="anchor" id="ad5e81d7f7b3728303469466afa8909dd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> &amp;&amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Allow instances of this class to be moved. </p>

</div>
</div>
<a class="anchor" id="a91b520f21421ff8fe1326635142276a9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Prevent instances of this class from being copied (As this class contains pointers) </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a5ae591df94fc66ccb85cbb6565368bca"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void close </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Closes file. </p>

</div>
</div>
<a class="anchor" id="a16182afd0af6163476284de586c66c9d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string filename </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns filename of the handled file. </p>
<dl class="section return"><dt>Returns</dt><dd>File filename </dd></dl>

</div>
</div>
<a class="anchor" id="aa6d6ff37ab6cae622a54e37c16dd53b2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void open </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>filename</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::ios_base::openmode&#160;</td>
          <td class="paramname"><em>mode</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Opens file. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>File name </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>File open mode </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a9ffd691a00a5c9080528c3b852bda144"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a>&amp; operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Prevent instances of this class from being copied (As this class contains pointers) </p>

</div>
</div>
<a class="anchor" id="a54f342231c056055100190a5429e4689"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a>&amp; operator= </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a> &amp;&amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Allow instances of this class to be moved. </p>

</div>
</div>
<a class="anchor" id="a480926182a1f0b657c56803bc0122386"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::fstream&amp; stream </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the file stream. </p>
<dl class="section return"><dt>Returns</dt><dd>File stream </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>arm_compute/core/utils/io/<a class="el" href="_file_handler_8h_source.xhtml">FileHandler.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespacearm__compute.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="namespacearm__compute_1_1io.xhtml">io</a></li><li class="navelem"><a class="el" href="classarm__compute_1_1io_1_1_file_handler.xhtml">FileHandler</a></li>
    <li class="footer">Generated on Fri Mar 2 2018 12:37:59 for Compute Library by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
